package com.csxy.hql;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {

    /**
     * 创建并配置 OpenAPI 实例。
     * <p>
     * 该实例包含 API 的基本信息、安全机制等，
     * 将用于生成交互式 API 文档界面（如 Swagger UI）。
     *
     * @return 返回配置好的 OpenAPI 实例
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                // 配置安全机制：Bearer JWT
                .components(new Components()
                        .addSecuritySchemes("bearerAuth", new SecurityScheme()
                                .type(SecurityScheme.Type.HTTP)
                                .scheme("bearer")
                                .bearerFormat("JWT")))
                // 设置文档元信息
                .info(new Info()
                        .title("教务系统API")
                        .description("在线教育平台接口文档")
                        .version("1.0")
                        .contact(new Contact().name("开发者").email("dev@example.com")))
                // 应用全局安全要求
                .addSecurityItem(new SecurityRequirement().addList("bearerAuth"));
    }
}